<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationJoinedGroup</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch06.html" title="Network abstraction">
<link rel="prev" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup">
<link rel="next" href="InfCommunicationFactory.html" title="InfCommunicationFactory">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfCommunicationHostedGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfCommunicationFactory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfCommunicationJoinedGroup.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfCommunicationJoinedGroup.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfCommunicationJoinedGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfCommunicationJoinedGroup.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="InfCommunicationJoinedGroup">
<a name="InfCommunicationJoinedGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationJoinedGroup.top_of_page"></a>InfCommunicationJoinedGroup</span></h2>
<p>InfCommunicationJoinedGroup — Communication group opened by a remote host</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfCommunicationJoinedGroup.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfCommunicationJoinedGroup.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/communication/inf-communication-joined-group.h&gt;

                    <a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroup-struct" title="InfCommunicationJoinedGroup">InfCommunicationJoinedGroup</a>;
struct              <a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroupClass" title="struct InfCommunicationJoinedGroupClass">InfCommunicationJoinedGroupClass</a>;
<span class="returnvalue">void</span>                <a class="link" href="InfCommunicationJoinedGroup.html#inf-communication-joined-group-remove-member" title="inf_communication_joined_group_remove_member ()">inf_communication_joined_group_remove_member</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *grp</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *  <a class="link" href="InfCommunicationJoinedGroup.html#inf-communication-joined-group-get-publisher" title="inf_communication_joined_group_get_publisher ()">inf_communication_joined_group_get_publisher</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *g</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfCommunicationJoinedGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup">InfCommunicationGroup</a>
         +----InfCommunicationJoinedGroup
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="InfCommunicationJoinedGroup.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroup--method" title='The "method" property'>method</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  "<a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroup--publisher" title='The "publisher" property'>publisher</a>"                <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>*     : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfCommunicationJoinedGroup.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> represents membership of the local host on a
<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> opened on a remote host.
</p>
<p>
There is no API to add a member to a joined group. This is because new
members can only join via the group's publisher. It is the job of the
<a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> to tell the joined group about the new member in
which case, the <a class="link" href="InfCommunicationGroup.html#InfCommunicationGroup-member-added" title='The "member-added" signal'><span class="type">"member-added"</span></a> signal will be
emitted.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfCommunicationJoinedGroup.details"></a><h2>Details</h2>
<div class="refsect2" title="InfCommunicationJoinedGroup">
<a name="InfCommunicationJoinedGroup-struct"></a><h3>InfCommunicationJoinedGroup</h3>
<pre class="programlisting">typedef struct _InfCommunicationJoinedGroup InfCommunicationJoinedGroup;</pre>
<p>
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> is an opaque data type. You should only
access it via the public API functions.
</p>
</div>
<hr>
<div class="refsect2" title="struct InfCommunicationJoinedGroupClass">
<a name="InfCommunicationJoinedGroupClass"></a><h3>struct InfCommunicationJoinedGroupClass</h3>
<pre class="programlisting">struct InfCommunicationJoinedGroupClass {
};
</pre>
<p>
This structure does not contain any public fields.
</p>
</div>
<hr>
<div class="refsect2" title="inf_communication_joined_group_remove_member ()">
<a name="inf-communication-joined-group-remove-member"></a><h3>inf_communication_joined_group_remove_member ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_communication_joined_group_remove_member
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *grp</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>
Removes <em class="parameter"><code>connection</code></em> as <em class="parameter"><code>grp</code></em>'s member. On the remote site, the
corresponding <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> needs to be freed (which may be a
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> or a <a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>grp</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A connection to a member of <em class="parameter"><code>grp</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_joined_group_get_publisher ()">
<a name="inf-communication-joined-group-get-publisher"></a><h3>inf_communication_joined_group_get_publisher ()</h3>
<pre class="programlisting"><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *  inf_communication_joined_group_get_publisher
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *g</code></em>);</pre>
<p>
Returns a <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to the group's publisher, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the
publisher is no longer a group member.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>g</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfCommunicationJoinedGroup.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "method" property'>
<a name="InfCommunicationJoinedGroup--method"></a><h3>The <code class="literal">"method"</code> property</h3>
<pre class="programlisting">  "method"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>The communication method to use for this group.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "publisher" property'>
<a name="InfCommunicationJoinedGroup--publisher"></a><h3>The <code class="literal">"publisher"</code> property</h3>
<pre class="programlisting">  "publisher"                <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>*     : Read / Write / Construct Only</pre>
<p>A connection to the group's publisher.</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="InfCommunicationJoinedGroup.see-also"></a><h2>See Also</h2>
<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>, <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>